home *** CD-ROM | disk | FTP | other *** search
/ Pascal Super Library / Pascal Super Library (CW International)(1997).bin / SHELLS / SZ2 / ADEMO7.DEF < prev    next >
Text File  |  1992-08-31  |  2KB  |  56 lines
  1. .TUTORIAL - Adding Help Text
  2.  
  3. Since this is identical to the prior example, we'll re-use the custom
  4. components and the definition.  The only thing new is the help text
  5. file (*.TXT).
  6.  
  7. First, you'll notice that the related *.TXT file is loaded along with
  8. the *.DEF file.  You can control this with the SETUP|IDE options.
  9.  
  10. Note that Help Text is compiled before the definition is processed.
  11.  
  12. The symbol file (*_X.PAS) is read, so that during the generate
  13. process help symbol names (hcXX) can be checked against SubMenu and
  14. Hint elements.  This gives the option of either adding just the
  15. symbols needed for help context, or appending new Hint Text to the
  16. actual Help Text file (*.TXT).
  17.  
  18. You will probably not use Help Text switches right away; they are
  19. meant to assist in the creation and maintainance of the *.TXT file.
  20. Here are brief descriptions:
  21.  
  22.                                  /ht0
  23.  
  24. Any hint text will be used to "dummy-up" a Help Text file.  This is a
  25. temporary file (named *.TX, not *.TXT) passed to the Help Compiler
  26. after generation is complete.
  27.  
  28.                                  /ht1
  29.  
  30. When you're ready to start work on the application's Help Text,
  31. activate this switch and regenerate.  Hint Text and hcXX symbols are
  32. appended to the related *.TXT file, if not already present.  If this
  33. switch is on and the definition is changed, any hcXX and Hint Text
  34. will be appended to the Help Text file the next time you generate.
  35.  
  36.                                  /ht2
  37.  
  38. If you have a Help Text file (*.TXT), but don't want to keep the
  39. "/ht1" switch active, this allows Hint Text to be temporarily used
  40. as Help Text for any missing hcXX references.
  41.  
  42.                                  /ht3
  43.  
  44. If Help Text is not important, such as during initial development or
  45. experimentation, this switch causes all Help Text to be ignored.  All
  46. help context symbols (hcXX) are generated and numbered by SHAZAM.
  47. Hint Text will be used, but no Help Text will be available.
  48.  
  49. See command-line switches or SETUP|Code dialog for more detail.
  50.  
  51. @PA - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  52.  
  53.  
  54. [ APPLICATION ] ademo6       ;;re-use prior stuff
  55. [ INCLUDE ] ademo6
  56.